// Copyright (c) 2009 Mike Haight, Andy Kipp
//
// Permission is hereby granted, free of charge, to any person
// obtaining a copy of this software and associated documentation
// files (the "Software"), to deal in the Software without
// restriction, including without limitation the rights to use,
// copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following
// conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.

#include "stdafx.h"

#pragma once

namespace HandBanana { namespace Game {
    /// <summary>
    /// A Layer represents a collection of WorldObjects to be drawn on the same Z plane in the World
    /// </summary>
    [XmlRoot(ElementName = "Layer")]
    public ref class Layer : System::Xml::Serialization::IXmlSerializable
    {
    // Public Methods
    public:

        /// <summary>
        /// Gets the name of the Layer
        /// </summary>
        property String^ Name
        {
            String^ get(void);
        }

        /// <summary>
        /// Gets or sets a Map associated with the Layer
        /// </summary>
        property Game::Map^ Map
        {
            Game::Map^ get(void);
        }

        /// <summary>
        /// Get a List of WorldObjects in the given Rectangle
        /// </summary>
        virtual List<WorldObject^>^ GetObjects(Coordinates::Rectangle argRectangle);

        /// <summary>
        /// Implements the IXmlSerializable::WriteXml method
        /// </summary>
        virtual void WriteXml(XmlWriter^ writer);

        /// <summary>
        /// Implements the IXmlSerializable::ReadXml method
        /// </summary>
        virtual void ReadXml(XmlReader^ reader);

        /// <summary>
        /// Implements the IXmlSerializable::GetSchema method
        /// </summary>        
        virtual XmlSchema^ GetSchema(void);

    // Constructors
    private:

        /// <summary>
        /// 
        /// </summary>
        Layer(void);

    // Private Data Members
    private:
        // Static Logger for this Class
        static NLog::Logger^                smLogger = NLog::LogManager::GetCurrentClassLogger();

        String^                             mName;
        Game::Map^                          mMap;

    };

} }

